Docs For Class Form

Description

Located in /include/class.form.php (line 23)

Variable Summary

mixed $config

mixed $dbconn

mixed $ds

mixed $lang

Method Summary

class Form (object $dbconn, array $config)

void addNewRegExp (mixed $regexp_data)

new addNewSection (array $section_data)

void addSectionAttribute (mixed $id_section, mixed $attr_data)

void attrSearch (mixed $id_attr, mixed $value, [mixed $id_user = ''])

void checkIfAttrIsConst (mixed $id_attr)

void checkIfSectionIsConst (mixed $id_section)

void deleteForm (mixed $id_form)

void delRegExp (mixed $regexp_id)

if delSection (int $id_section)

void delSectionAttribute (mixed $id_attr)

void delUserAttributes (mixed $id_user)

unknown getAllAttributes (int &$total_count, [str $filter_str = ''], [str $order_by = ''], [mixed $ids_only = false])

void getAllDataSources ()

void getAllUserData (mixed $id_user, [mixed $convert_to_str = false])

void getControlType (mixed $control_type)

void getDataSourceValues (mixed $ds_id)

attributes getFormAttributes (int $id_form)

void getRegExps ()

section getSection (int $id_section)

attribute getSectionAttribute (int $id_attr)

all getSectionAttributes (int $id_section, int &$total_count, [int $id_form = ''])

all getSections ()

user getUserAttribute (int $id_user, int $id_attr, [bool $convert_to_str = false])

void getUserSectionData (mixed $id_user, mixed $id_section, [mixed $convert_to_str = false])

void saveUserAttribute (int $id_user, int $id_attr, array $new_value)

void saveUserAttributes (mixed $id_user, mixed $attrs)

void toDate (mixed $id_user, mixed $id_date_attr)

void updateForm (mixed $id_form, array $attrs, int $id_block)

void updateRegExps (mixed $regs)

void updateSectionAttribute (mixed $id_attr, mixed $attr_data)

Variables

mixed $config (line 25)

mixed $dbconn (line 24)

mixed $ds (line 26)

mixed $lang (line 27)

Methods

Constructor Form (line 35)

Class Constructor

return: object

class Form (object $dbconn, array $config)

object $dbconn: - ADODB connection
array $config: - config array

addNewRegExp (line 475)

void addNewRegExp (mixed $regexp_data)

addNewSection (line 322)

Adds new section

return: section id

new addNewSection (array $section_data)

array $section_data: - New section data

addSectionAttribute (line 350)

void addSectionAttribute (mixed $id_section, mixed $attr_data)

attrSearch (line 648)

void attrSearch (mixed $id_attr, mixed $value, [mixed $id_user = ''])

checkIfAttrIsConst (line 502)

void checkIfAttrIsConst (mixed $id_attr)

checkIfSectionIsConst (line 494)

void checkIfSectionIsConst (mixed $id_section)

deleteForm (line 111)

void deleteForm (mixed $id_form)

delRegExp (line 482)

void delRegExp (mixed $regexp_id)

delSection (line 338)

Deletes specified section

return: success returns true, otherwise false

if delSection (int $id_section)

int $id_section: - Section ID

delSectionAttribute (line 432)

void delSectionAttribute (mixed $id_attr)

delUserAttributes (line 642)

void delUserAttributes (mixed $id_user)

getAllAttributes (line 285)

Gets all existing attributes using filter and order

unknown getAllAttributes (int &$total_count, [str $filter_str = ''], [str $order_by = ''], [mixed $ids_only = false])

int &$total_count: - total returned attributes count
str $filter_str: - SQL query filter
str $order_by: - SQL query order

getAllDataSources (line 48)

void getAllDataSources ()

getAllUserData (line 583)

void getAllUserData (mixed $id_user, [mixed $convert_to_str = false])

getControlType (line 221)

void getControlType (mixed $control_type)

getDataSourceValues (line 52)

void getDataSourceValues (mixed $ds_id)

getFormAttributes (line 78)

Gets all specified form attributes

return: array

attributes getFormAttributes (int $id_form)

int $id_form: - Form ID

getRegExps (line 454)

void getRegExps ()

getSection (line 121)

Gets specified section data

return: data

section getSection (int $id_section)

int $id_section: - Section ID

getSectionAttribute (line 160)

Gets specified section attribute

return: data

attribute getSectionAttribute (int $id_attr)

int $id_attr: - Attribute ID

getSectionAttributes (line 240)

Gets all specified section attributes

return: section attributes

all getSectionAttributes (int $id_section, int &$total_count, [int $id_form = ''])

int $id_section: - Section ID
int $total_count: - Total count of returned attributes
int $id_form: - If specified will be used to filter attributes

getSections (line 140)

Gets all sections

return: section data

all getSections ()

getUserAttribute (line 534)

Gets user attribute value in various formats (view/edit), depending on last parametr

return: attribute value

user getUserAttribute (int $id_user, int $id_attr, [bool $convert_to_str = false])

int $id_user: - User ID
int $id_attr: - Attribute ID
bool $convert_to_str: - Determines is data for display, or data for edit

getUserSectionData (line 510)

void getUserSectionData (mixed $id_user, mixed $id_section, [mixed $convert_to_str = false])

saveUserAttribute (line 605)

Saves user attibute (inserts new if not exists, or updates existing)

void saveUserAttribute (int $id_user, int $id_attr, array $new_value)

int $id_user: - User ID
int $id_attr: - Attribute ID
array $new_value: - New attribue data

saveUserAttributes (line 635)

void saveUserAttributes (mixed $id_user, mixed $attrs)

toDate (line 662)

void toDate (mixed $id_user, mixed $id_date_attr)

updateForm (line 102)

Updates form block

void updateForm (mixed $id_form, array $attrs, int $id_block)

int $id_block: - Block ID
array $attrs: - New Block Attributes

updateRegExps (line 487)

void updateRegExps (mixed $regs)

updateSectionAttribute (line 383)

void updateSectionAttribute (mixed $id_attr, mixed $attr_data)